<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/struc/shm/arena_lend/jemalloc/jemalloc_fwd.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_18de54d40c020a62dfebd12c68fa56ae.html">transport</a></li><li class="navelem"><a class="el" href="dir_b8aa7e2e9741fa9cbe830a8616b13cfd.html">struc</a></li><li class="navelem"><a class="el" href="dir_e51dab5e9c0cdbd0180a6b7afdbe8a41.html">shm</a></li><li class="navelem"><a class="el" href="dir_6a9154929a3cacbead8390e6681e37b8.html">arena_lend</a></li><li class="navelem"><a class="el" href="dir_420eb5c69419e70df9303f96761e9dfb.html">jemalloc</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">jemalloc_fwd.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="transport_2struc_2shm_2arena__lend_2jemalloc_2jemalloc__fwd_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: SHM-jemalloc</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright (c) 2023 Akamai Technologies, Inc.; and other contributors.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * Each commit is copyright by its respective author or author&#39;s employer.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * Licensed under the MIT License:</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> *</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * of this software and associated documentation files (the &quot;Software&quot;), to deal</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * in the Software without restriction, including without limitation the rights</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * furnished to do so, subject to the following conditions:</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> *</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * The above copyright notice and this permission notice shall be included in</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * all copies or substantial portions of the Software.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> *</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * THE SOFTWARE. */</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"></span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;ipc/shm/arena_lend/jemalloc/jemalloc_fwd.hpp&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &quot;<a class="code" href="transport_2struc_2shm_2shm__fwd_8hpp.html">ipc/transport/struc/shm/shm_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">/// See parent ipc::transport::struc::shm and at least sub-namespace ipc::transport::struc::shm::arena_lend::jemalloc.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend.html">ipc::transport::struc::shm::arena_lend</a> { }</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">// @todo Perhaps move into a ../arena_lend_fwd.hpp; may be more of a thing once/if more arena_lend SHM-providers exist.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"></span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment">/**</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * As of this writing certain convenience aliases supplied for the SHM-jemalloc SHM-provider as pertains to</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * zero-copy structured message passing with that SHM-provider.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> *</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * @see ipc::transport::struc::shm doc header.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> */</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html">ipc::transport::struc::shm::arena_lend::jemalloc</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>{</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment">/// Convenience alias: `transport::struc::shm::Builder` that works with SHM-jemalloc arenas.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a95831556fc3cacf93de0bc96f4db3e13">   47</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a95831556fc3cacf93de0bc96f4db3e13">Builder</a> = <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a95831556fc3cacf93de0bc96f4db3e13">Builder&lt;ipc::shm::arena_lend::jemalloc::Ipc_arena&gt;</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"></span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment">/// Convenience alias: `transport::struc::shm::Reader` that works with SHM-jemalloc arenas.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a94304eb7db7c7d7c8df1ff8aa3806913">   50</a></span><span class="comment"></span><span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a94304eb7db7c7d7c8df1ff8aa3806913">Reader</a> = <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a94304eb7db7c7d7c8df1ff8aa3806913">Reader&lt;ipc::shm::arena_lend::jemalloc::Ipc_arena&gt;</a>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span>} <span class="comment">// namespace ipc::transport::struc::shm::arena_lend::jemalloc</span></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html">ipc::transport::struc::shm::arena_lend::jemalloc</a></div><div class="ttdoc">As of this writing certain convenience aliases supplied for the SHM-jemalloc SHM-provider as pertains...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2arena__lend_2jemalloc_2jemalloc_8hpp_source.html#l00030">jemalloc.hpp:31</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc_html_a94304eb7db7c7d7c8df1ff8aa3806913"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a94304eb7db7c7d7c8df1ff8aa3806913">ipc::transport::struc::shm::arena_lend::jemalloc::Reader</a></div><div class="ttdeci">Reader&lt; ipc::shm::arena_lend::jemalloc::Ipc_arena &gt; Reader</div><div class="ttdoc">Convenience alias: transport::struc::shm::Reader that works with SHM-jemalloc arenas.</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2arena__lend_2jemalloc_2jemalloc__fwd_8hpp_source.html#l00050">jemalloc_fwd.hpp:50</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc_html_a95831556fc3cacf93de0bc96f4db3e13"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_1_1jemalloc.html#a95831556fc3cacf93de0bc96f4db3e13">ipc::transport::struc::shm::arena_lend::jemalloc::Builder</a></div><div class="ttdeci">Builder&lt; ipc::shm::arena_lend::jemalloc::Ipc_arena &gt; Builder</div><div class="ttdoc">Convenience alias: transport::struc::shm::Builder that works with SHM-jemalloc arenas.</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2arena__lend_2jemalloc_2jemalloc__fwd_8hpp_source.html#l00047">jemalloc_fwd.hpp:47</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend_html"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1arena__lend.html">ipc::transport::struc::shm::arena_lend</a></div><div class="ttdoc">See parent ipc::transport::struc::shm and at least sub-namespace ipc::transport::struc::shm::arena_le...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2arena__lend_2jemalloc_2jemalloc_8hpp_source.html#l00030">jemalloc.hpp:31</a></div></div>
<div class="ttc" id="atransport_2struc_2shm_2shm__fwd_8hpp_html"><div class="ttname"><a href="transport_2struc_2shm_2shm__fwd_8hpp.html">shm_fwd.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
